home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 029a / scc.zip / SAMPLE.V2 < prev    next >
Text File  |  1991-09-11  |  13KB  |  326 lines
  1.            *** Please Read the following information ***
  2.  
  3.   The SCC generated sample.log file should be viewed from within the
  4. SCC VIEW utility. Therefor to build the sample.log file, start by 
  5. typing at the DOS prompt "sample". This "sample.bat" (batch) file will 
  6. automaticaly build the log file. The "sample.bat" (batch) file will
  7. also bring up the SCC VIEW utility. Then continue reading the following.
  8.  
  9.   Invest only 15 minutes of your time, and discover the "Advantage" of
  10. SCC's small CASE utility and its ease of use. This example log file
  11. will review a typical SCC generated change LOG.
  12.  
  13.   Some of the "LOG" build options set (see above log header) for this
  14. SCC example VIEW utility are set as:
  15.  
  16.      Group  Match     = 6
  17.      Log    Detail    = Yes      fixed default for Sharware
  18.      Strip  End White = No       strip ending white space from Old/New
  19.      Ignore Case      = Yes     
  20.      Ignore White     = Yes
  21.      Ignore Numbers   = Yes
  22.  
  23.   If you have a color monitor (for the enhanced view), please note:
  24.  
  25.   1) Main "text" screen attributes   (foreground/background):
  26.  
  27.      o CONTROL      = High  White & Blue  Background.
  28.      o Old Document = Light White & Blue  Background.
  29.      o New Document = Yellow      & Blue  Background.
  30.  
  31.   2) Cursor line attributes:
  32.  
  33.      o Cursor       = Black       & Cyan  Background.
  34.  
  35.  
  36.         Note... The log status within the cursor position will show 
  37.      special symbol that reflect the SCC Log control operations, such
  38.      characters as  '-', '+', '.' or blank ' '.
  39.      
  40.         When the cursor is on a Log line (the left control side) that
  41.      has either '-', or '+', then one of the following line operations
  42.      will apply.
  43.  
  44.      
  45.      Log status   Operation         
  46.      ----------   ---------         
  47.             '-'   " Deleted  Line   
  48.             '+'   " Inserted Line   
  49.  
  50.  
  51.         When the cursor is on a Log line (the left control side) that
  52.      equals a blank character ' 'one of the following line operations
  53.      apply. This greatly simplifies the reading of the printed Log,
  54.      thus helping to eliminate (unimportant) selected changes.
  55.  
  56.  
  57.      Log status   Operation           
  58.      ----------   ---------           
  59.             ' '   " Moved  Line      "
  60.             ' '   " Ignore White Sp  "
  61.             ' '   " Ignore Numbers   "
  62.             ' '   " Ignore Case      "
  63.             ' '   " Multi  Opt Match "
  64.  
  65.      
  66.         When the cursor is on a Log line (the left control side) that
  67.      has a period '.', then that line is common to both the files Old
  68.      and New.
  69.  
  70.  
  71.      Log status   Operation           
  72.      ----------   ---------           
  73.             '.'   " Common Lines     "
  74.  
  75.  
  76.         The above SCC Log (along with different SCC Log option settings)
  77.      can help generate a "filtered" SCC change control report Log to
  78.      what is important (delete or insert status) and not important
  79.      (blank status) in your file.
  80.         For example you may not want the '-' or '+' (delete or insert)
  81.      Log status characters for such lines containing differences of 
  82.      only "White Space", "Upper/Lower Case" etc.
  83.  
  84.      At any time you may press the
  85.             F1 key for the       help menu.
  86.             F2 key for the QUICK help menu.
  87.  
  88.  
  89.  
  90.  
  91.   START OF EXAMPLES.....
  92.   " Common Lines    "
  93.      Common Line numbers between the Old and New documents. Cursor
  94.      status will show the corresponding Old line #.
  95.  
  96.  
  97.  
  98.  
  99.  
  100.   " Inserted Lines  "
  101.      Will show what line and line # that was inserted into the New.
  102.   " Ignore White Sp "
  103.      All the text match except for white space between documents.
  104.   " Ignore 1234 Numbers "
  105.      4321 All the text match except for numbers 5678between documents.
  106.   " Ignore Case     "
  107.      All the text match except for upper/lower case between documents.
  108.   " Multi 456 Match    "
  109.      All the TEXT match by using two 3 or more options between the OLD
  110.      and NEW documents.    For example if the option "Ignore Case" and
  111.      "Ignore numbers" allowed the 456 lines match then this status.
  112.   " Moved  Lines    "
  113.      These are exact matching lines between documents but may have
  114.      different line numbers.
  115.   Strip End White        
  116.        If "Strip End White" was selected the following lines will be
  117.      exactly alike (same length) and would show as "Common Lines".
  118.        If "Strip End White" was ** NOT ** selected then the lines
  119.      will be of different lengths.
  120.   Common lines
  121.      These lines are common between the Old and New documents.
  122.  
  123.   ** Note ** SCC can also track and VIEW any (ASCII TEXT)
  124.      formatted document such as the following.
  125.  
  126.  
  127.  
  128.  
  129. Page 1                         Overview.scc
  130.  
  131.                       Software Change Control (SCC)
  132.  
  133.                               Softime Systems
  134.                                P.O. Box 2447
  135.                        Lake Ronkonkoma LI. NY 11779
  136.                               (516) 981-8386
  137.  
  138.                   Copyright (c) 1990-91 by Walter Erickson
  139.                            All Rights Reserved.
  140.  
  141.  
  142.                       "A small CASE for a big problem"
  143.                               Mary J Erickson
  144.  
  145.  
  146.  
  147. Page 2
  148.                                  Overview 
  149.                         Common questions about SCC
  150.  
  151.                                What is SCC ?
  152.                                -------------
  153.   Software Change Control (SCC), as the name implies, is one of the most
  154. powerful and cost-effective tool available in this emerging field of CASE.
  155. SCC features friendly menu-driven interfaces (with automatic context help)
  156. suitable for use by non-technical administrative, as well as for the
  157. sophisticated user.
  158.  
  159.   SCC closely tracks (logs) all software/text changes between two similar
  160. source files, thereby giving a complete (version to version) audit trail.
  161.  
  162.   A SCC generated Log greatly simplifies any user request for the
  163. (identification) of what, when and why changes were made.
  164.  
  165.                             What does SCC do ?
  166.                             ------------------
  167.   When SCC is run the tracking (output) log file will then reflect (in
  168. context) what changes have occurred between the two (input) source files,
  169. thus allowing the programmer and/or management to have a clear visual SCC
  170. log of all software and/or text changes.
  171.  
  172.   This feature enables the user to control all enhancements and
  173. documentation of source data at this critical level.
  174.  
  175.                             Why is SCC needed ?
  176.                             -------------------
  177.   All software source files will need changes. In fact, it is a truism that
  178. every software project released, including those released quite recently,
  179. need changes. The most important consideration at this stage is to regulate
  180. and control the documentation and its changes.
  181.  
  182.   SCC is a decomposition process that offers a complete and precise
  183. description of what (line-by-line) changes have occurred between two source
  184. files. This results in faster development time, along with software that is
  185. far less likely to fail in use.
  186.  
  187. Page 3
  188.                           Can managers use SCC ?
  189.                           ----------------------
  190.   The management of software changes at the programming (source) level
  191. (generally accepted as the most expensive and weakest link in software
  192. management) is one of the most difficult problems managers and programmers
  193. alike have.
  194.  
  195.   Using SCC creates an environment that is very time and cost effective.
  196. SCC allows changes to be made in a more maintainable, reliable and
  197. controllable way; that is, software control is fully documented, along with
  198. a full audit trail of what changes have occurred between software versions.
  199.  
  200.   SCC greatly improves the suitability and appropriateness of software
  201. change documents; enhances clarity, readability, reliability and complete
  202. recoverability; allowing software changes to be a great deal easier to
  203. track and maintain.
  204.  
  205.                     Does SCC require a special editor ?
  206.                     -----------------------------------
  207.   No, all that is required is that the input source files to SCC be in
  208. (ASCII TEXT) format.
  209.  
  210.                       Does SCC require a data base ?
  211.                       ------------------------------
  212.   No, SCC can either be integrated into a data base or stand alone, for
  213. most small projects a data base is not necessary, thus eliminating
  214. complexity and cost (KISS). All header file-id, code and documentation
  215. changes "between versions" are kept within the SCC Log itself.
  216.  
  217.                  Can I run SCC against existing versions ?
  218.                  -----------------------------------------
  219.   Yes, you can build new and complete SCC change logs from older existing
  220. (version to version) files, this will give a entire audit trail of any
  221. software changes between versions. 
  222.  
  223.                         What can SCC be used for ?
  224.                         --------------------------
  225.     o  Documenting
  226.     o  Software/text control
  227.     o  Software Debugging
  228.     o  version pre-release (development) change control
  229.     o  Code walkthrough's
  230.     o  etc.
  231.  
  232.                          Using SCC for Documenting
  233.                          -------------------------
  234.   When SCC is run, the tracking (output) log file will then reflect (in
  235. context) what changes that have occurred between the two (input) source
  236. files, thus allowing the programmer and/or management to control, enhance
  237. and document software at this critical source level.
  238.  
  239.   SCC generates a software change (log) that closely tracks and records all
  240. changes consisting of a header, control change numbers and special symbols
  241. to reflect the operations of delete '-', insert '+', move ' ' etc.
  242.  
  243. Page 4
  244.                       Using SCC for Software control
  245.                       ------------------------------
  246.   The manager/programmer can visually see on one listing (the change log)
  247. all changes and special tracking symbols that were necessary to build the
  248. later version from the earlier version, thus keeping an accurate control
  249. over all changes.
  250.  
  251.   SCC will also reveal all unintentional and possible unauthorized changes
  252. to source files, thus preventing future problems in the next released
  253. version.
  254.  
  255.   SCC helps the programmer and manager to make changes, "edit out" any
  256. tactical coding/design errors between two source files. This can be done by
  257. using a similar method such as the following:
  258.  
  259.   Initial Technical Design Review
  260.     o  revision of raw draft coding design
  261.     o  clarification of ambiguous design content
  262.     o  identification of coding gaps and inconsistencies
  263.     o  discovery of major/minor coding errors
  264.  
  265.   Quick Coding Review
  266.     o  verification of technical content NOT already tested or
  267.        debugged
  268.     o  incorporation of late technical coding changes
  269.     o  writing specs for changed documentation
  270.  
  271.   Final Technical Design Review
  272.     o  refining the source code/documentation for usability
  273.     o  minor "edit" cleanup
  274.     o  careful configuration control and test proofing
  275.  
  276.   Field Maintenance of Released Software
  277.     o  discovery of unintentional coding errors
  278.     o  discovery of undocumented features
  279.     o  uncovering code that once worked, but now does not
  280.     o  SCC Log header information for release identification and control
  281.  
  282. Page 5
  283.                                 SCC summary
  284.                                 -----------
  285.   SCC is a comprehensive utility designed to compare two files and generate
  286. various reports (log files) that display any or all change differences as
  287. they evolve.
  288.  
  289.   SCC log records who, why, when and where changes were made, thus
  290. maintaining a complete history of all changes.
  291.  
  292.   SCC enables detailed verification of auditing accuracy, eliminates
  293. undetected programming errors and drastically reduces manual desk checking
  294. time.
  295.  
  296.   The manager/programmer knows exactly what the changes are between
  297. versions.
  298.  
  299.   SCC accepts (ASCII TEXT) output from your favored editor.
  300.  
  301.   You can build new and complete SCC change logs from older existing
  302. (version to version) files.
  303.  
  304.   You can track any coding progress on software changes by viewing an SCC
  305. log against the previous and/or developing files.
  306.  
  307.   You can backtrack to any previous version to examine what changes created
  308. that release at that time.
  309.  
  310.   SCC change log report (version to version) can greatly help in debugging
  311. changes between versions (one works the other does not).
  312.  
  313.   You can build new and complete SCC change logs from older existing
  314. (version to version) files.
  315.  
  316.   The key benefits of SCC are:
  317.     o  lower project costs
  318.     o  controlled release management
  319.     o  structured walkthroughs
  320.     o  faster software coding thruput
  321.     o  higher software quality
  322.  
  323.      If you would like further information about this or the SCC registered
  324.      programs, please call Walter Erickson at (516) 981-8386
  325.  
  326.